/*
 * The contents of this file are subject to the terms of the Common Development and
 * Distribution License (the License). You may not use this file except in compliance with the
 * License.
 *
 * You can obtain a copy of the License at legal/CDDLv1.0.txt. See the License for the
 * specific language governing permission and limitations under the License.
 *
 * When distributing Covered Software, include this CDDL Header Notice in each file and include
 * the License file at legal/CDDLv1.0.txt. If applicable, add the following below the CDDL
 * Header, with the fields enclosed by brackets [] replaced by your own identifying
 * information: "Portions Copyright [year] [name of copyright owner]".
 *
 * Copyright 2008-2009 Sun Microsystems, Inc.
 * Portions Copyright 2011-2016 ForgeRock AS.
 */
package org.opends.server.loggers;

import java.io.Closeable;
import java.util.List;

import org.forgerock.i18n.LocalizableMessage;
import org.forgerock.opendj.server.config.server.LogPublisherCfg;
import org.forgerock.opendj.config.server.ConfigException;
import org.opends.server.core.ServerContext;
import org.forgerock.opendj.ldap.DN;
import org.opends.server.types.InitializationException;

/**
 * This class defines the set of methods and structures that must be implemented
 * for a Directory Server log publisher.
 *
 * @param <T>
 *          The type of log publisher configuration handled by this log
 *          publisher implementation.
 */
@org.opends.server.types.PublicAPI(
    stability = org.opends.server.types.StabilityLevel.VOLATILE,
    mayInstantiate = false,
    mayExtend = true,
    mayInvoke = false)
public interface LogPublisher<T extends LogPublisherCfg> extends Closeable
{

  /**
   * Initializes this publisher provider based on the information in the
   * provided debug publisher configuration.
   *
   * @param config
   *          The publisher configuration that contains the information to use
   *          to initialize this publisher.
   * @param serverContext
   *          The server context.
   * @throws ConfigException
   *           If an unrecoverable problem arises in the process of performing
   *           the initialization as a result of the server configuration.
   * @throws InitializationException
   *           If a problem occurs during initialization that is not related to
   *           the server configuration.
   */
  void initializeLogPublisher(T config, ServerContext serverContext) throws ConfigException,
      InitializationException;



  /**
   * Indicates whether the provided configuration is acceptable for this log
   * publisher. It should be possible to call this method on an uninitialized
   * log publisher instance in order to determine whether the log publisher
   * would be able to use the provided configuration.
   * <BR><BR>
   * Note that implementations which use a subclass of the provided
   * configuration class will likely need to cast the configuration to the
   * appropriate subclass type.
   *
   * @param configuration
   *          The log publisher configuration for which to make the
   *          determination.
   * @param unacceptableReasons
   *          A list that may be used to hold the reasons that the provided
   *          configuration is not acceptable.
   * @return {@code true} if the provided configuration is acceptable for this
   *         log publisher, or {@code false} if not.
   */
  boolean isConfigurationAcceptable(T configuration,
      List<LocalizableMessage> unacceptableReasons);



  /**
   * Close this publisher.
   */
  @Override
  void close();



  /**
   * Gets the DN of the configuration entry for this log publisher.
   *
   * @return The configuration entry DN.
   */
  DN getDN();

}
